Skip to content

Feat: allow to fetch subscription#4

Merged
patienceigiraneza merged 2 commits intomainfrom
features
Jun 5, 2025
Merged

Feat: allow to fetch subscription#4
patienceigiraneza merged 2 commits intomainfrom
features

Conversation

@patienceigiraneza
Copy link
Contributor

@patienceigiraneza patienceigiraneza commented Jun 5, 2025 •
edited by qodo-code-review bot
Loading

PR Type

documentation, enhancement

Description

  • Update default API host from port 8000 to 8001

    • Changes in documentation and codebase for new default host

  • Update package version from 2.0.0 to 1.0.0

  • Revise README and docs for new installation and authentication details

  • Remove test files from OpenAPI generator file list

Changes walkthrough 📝

Relevant files
Enhancement
2 files
setup.py
Change package version to 1.0.0                                                   
+1/-1     
configuration.py
Update default API host to port 8001                                         
+2/-2     
Configuration changes
1 files
FILES
Remove test files from OpenAPI generator file list             
+0/-18   
Documentation
16 files
README.md
Update documentation for new host and installation             
+10/-12 
ChangeQuotaApi.md
Update API host in documentation to port 8001                       
+3/-3     
CreateAliasApi.md
Update API host in documentation to port 8001                       
+3/-3     
DeleteAliasApi.md
Update API host in documentation to port 8001                       
+3/-3     
DeleteEmailApi.md
Update API host in documentation to port 8001                       
+3/-3     
DnsInfoApi.md
Update API host in documentation to port 8001                       
+3/-3     
DomainAliasApi.md
Update API host in documentation to port 8001                       
+3/-3     
DomainApi.md
Update API host in documentation to port 8001                       
+3/-3     
DomainInfoApi.md
Update API host in documentation to port 8001                       
+3/-3     
GetTokenApi.md
Update API host in documentation to port 8001                       
+3/-3     
ImportApi.md
Update API host in documentation to port 8001                       
+3/-3     
RefreshTokenApi.md
Update API host in documentation to port 8001                       
+3/-3     
ResetPasswordApi.md
Update API host in documentation to port 8001                       
+3/-3     
SubscriptionInfoApi.md
Update API host in documentation to port 8001                       
+3/-3     
SubscriptionsApi.md
Update API host in documentation to port 8001                       
+9/-9     
UpgradeApi.md
Update API host in documentation to port 8001                       
+3/-3     
Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
    •

    @qodo-code-review
    Copy link

    qodo-code-review bot commented Jun 5, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Version Downgrade

    Package version is being downgraded from 2.0.0 to 1.0.0, which is unusual for semantic versioning. This could cause compatibility issues for users who expect newer versions to have higher version numbers.

     
    VERSION = "1.0.0"
PYTHON_REQUIRES = ">= 3.9"
    Repository Link

    The installation instructions in README.md have been changed from a specific repository link to a generic placeholder (GIT_USER_ID/GIT_REPO_ID), which will prevent users from being able to install the package.

     
    pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
    
</details>

<details><summary><a href='https://github.com/truehostcloud/workplace-console-client/pull/4/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R150-R152'><strong>Authentication Change</strong></a>

Authentication scheme has been changed from Bearer authentication to HTTP basic authentication without explanation in the PR description. This is a breaking change for existing users.
</summary>

```markdown
### Basic

- **Type**: HTTP basic authentication

    @qodo-code-review
    Copy link

    qodo-code-review bot commented Jun 5, 2025 •
    edited
    Loading

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    Fix installation instructions

    The installation instructions contain placeholder repository URLs
    (GIT_USER_ID/GIT_REPO_ID) instead of the actual repository path. This will
    prevent users from being able to install the package correctly.

    README.md [20-23]

     ```sh
-pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+pip install git+https://github.com/truehostcloud/workplace-console-client.git

    -(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
    +(you may need to run pip with root permission: sudo pip install git+https://github.com/truehostcloud/workplace-console-client.git)

    
- [ ] **Apply / Chat** <!-- /improve --apply_suggestion=0 -->

<details><summary>Suggestion importance[1-10]: 8</summary>

__

Why: The installation instructions now contain placeholder URLs (`GIT_USER_ID/GIT_REPO_ID`) instead of actual repository paths, which will prevent users from installing the package correctly.


</details></details></td><td align=center>Medium

</td></tr><tr><td>



<details><summary>✅ <s>Fix version downgrade issue</s></summary>

___

<details><summary><b>Suggestion Impact:</b></summary>The commit implemented exactly what the suggestion recommended - changing the version from 1.0.0 to 2.0.0 to avoid semantic versioning issues

code diff:

```diff
-VERSION = "1.0.0"
+VERSION = "2.0.0"

    The version number has been downgraded from 2.0.0 to 1.0.0, which could break
    semantic versioning expectations. Downgrading version numbers is generally not
    recommended as it can confuse dependency management systems and users.

    setup.py [25]

    -VERSION = "1.0.0"
+VERSION = "2.0.0"

    [Suggestion processed]

    Suggestion importance[1-10]: 6

    __

    Why: The version was downgraded from 2.0.0 to 1.0.0, which could break semantic versioning expectations and confuse dependency management systems, though this change might be intentional.

    		Low
    General
    Restore proper package description

    The package description has been changed to a generic "Test description" which
    appears to be placeholder text. This should be replaced with the actual package
    description to maintain proper documentation.

    README.md [1-2]

     # workplace-console-client
-Test description
+This is the Truehost's pip package for using the workplace console API from other python applications.
    • Apply / Chat
    Suggestion importance[1-10]: 7

    __

    Why: The package description was changed from a proper description to placeholder text "Test description", which reduces documentation quality and user understanding.

    		Medium
    • Update

    @patienceigiraneza patienceigiraneza merged commit 530d81c into main Jun 5, 2025
    10 checks passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    No reviews

    Assignees

    No one assigned

    Labels

    Review effort 2/5

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    1 participant

    @patienceigiraneza